Connectathon 11 Snapshot
This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
SDC System for completing forms
{
"resourceType": "Conformance",
"id": "conformance-sdc-form-filler",
"text": {
"status": "generated",
"div": "<div>\n \n <h2>SDC Form Filler</h2>\n \n <p>(Requirements Definition)</p>\n \n <p>Published: 2014-07-06 (draft)</p>\n \n <p>Published by: \n <b>U.S. Office of the National Coordinator (ONC)</b>\n \n </p>\n \n <p>This profile defines the expected capabilities of the \n <i>SDC Form Filler</i> role when conforming to the S&I Framework's \n <a href=\"sdc.html\">Structured Data Capture FHIR implementation guide</a>. This role is responsible for retrieving pre-defined forms, requesting pre-population of forms and/or auto-populating forms, guiding the user through verifying populated data and submitting completed or partially-completed forms.\n </p>\n \n <p>Note that Form Fillers may also take on the role of \n <a href=\"conformance-sdc-form-archiver.html\">Form Archiver</a> if they have a requirement to retain the completed version of a form (and potentially the source data that was used to complete it).\n </p>\n \n <h2>General</h2>\n \n <table>\n \n <tbody>\n \n <tr>\n \n <th>FHIR Version:</th>\n \n <td>1.2.0</td>\n \n </tr>\n \n <tr>\n \n <th>Supported formats:</th>\n \n <td>xml, json</td>\n \n </tr>\n \n </tbody>\n \n </table>\n \n <h2>REST behavior</h2>\n \n <p>The \n <a href=\"../questionnaire.html\">Questionnaire</a> and \n <a href=\"../valueset.html\">ValueSet</a> resources are retrieved to allow the system to guide the user through the entry process. The \n <a href=\"../binary.html\">Binary</a> and \n <a href=\"../documentreference.html\">DocumentReference</a> resources allow the system to find existing clinical documents that can be within the pre-population process. (Support for retrieval operations on these resources is optional as the relevant CDA or FHIR structures may also be directly generated by the \n <i>Form Filler</i> itself.) Finally, the \n <a href=\"../questionnaireresponse.html\">QuestionnaireResponse</a> resource is used to record the populated form.\n </p>\n \n <p>\n \n <b>Security:</b>\n \n </p>\n \n <p>Implementations must meet the general security requirements documented in the \n <a href=\"sdc-security.html\">SDC implementation guide</a>.\n </p>\n \n <h3>Resource summary</h3>\n \n <table class=\"grid\">\n \n <thead>\n \n <tr>\n \n <th>Resource</th>\n \n <th>Search</th>\n \n <th>Read</th>\n \n <th>Read Version</th>\n \n <th>Instance History</th>\n \n <th>Resource History</th>\n \n <th>Create</th>\n \n <th>Update</th>\n \n <th>Delete</th>\n \n </tr>\n \n </thead>\n \n <tbody>\n \n <tr>\n \n <th>Questionnaire (\n <a href=\"http://hl7.org/fhir/StructureDefinition/sdc-questionnaire\">Profile</a>)\n </th>\n \n <td>\n \n <a title=\"Allows discovery of existing questionnaires to be completed\" href=\"#Questionnaire-search-type\">SHALL</a>\n \n </td>\n \n <td>\n \n <a title=\"Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id.\" href=\"#Questionnaire-read\">SHOULD</a>\n \n </td>\n \n <td>\n \n <a title=\"Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only.\" href=\"#Questionnaire-vread\">MAY</a>\n \n </td>\n \n <td>\n \n <a title=\"Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most.\" href=\"#Questionnaire-history-instance\">MAY</a>\n \n </td>\n \n <td/>\n \n <td/>\n \n <td/>\n \n <td/>\n \n </tr>\n \n <tr>\n \n <th>ValueSet (\n <a href=\"http://hl7.org/fhir/StructureDefinition/sdc-valueset\">Profile</a>)\n </th>\n \n <td/>\n \n <td>\n \n <a title=\"Allows retrieval of a specific value set by id (as referenced in a Questionnaire)\" href=\"#ValueSet-read\">SHALL</a>\n \n </td>\n \n <td>\n \n <a title=\"Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)\" href=\"#ValueSet-vread\">SHOULD</a>\n \n </td>\n \n <td>\n \n <a title=\"Allows review of changes to a value set over time. Of interest to some systems, but probably not most.\" href=\"#ValueSet-history-instance\">MAY</a>\n \n </td>\n \n <td/>\n \n <td/>\n \n <td/>\n \n <td/>\n \n </tr>\n \n <tr>\n \n <th>QuestionnaireResponse (\n <a href=\"http://hl7.org/fhir/StructureDefinition/sdc-element\">Profile</a>)\n </th>\n \n <td>\n \n <a title=\"Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update.\" href=\"#QuestionnaireResponse-search-type\">SHALL</a>\n \n </td>\n \n <td/>\n \n <td/>\n \n <td>\n \n <a title=\"Allows review of prior versions of an answer set - allows reversion to previously recorded versions\" href=\"#QuestionnaireResponse-history-instance\">SHOULD</a>\n \n </td>\n \n <td/>\n \n <td>\n \n <a title=\"Allows recording a completed or partially-completed form\" href=\"#QuestionnaireResponse-create\">SHALL</a>\n \n </td>\n \n <td>\n \n <a title=\"Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)\" href=\"#QuestionnaireResponse-update\">SHALL</a>\n \n </td>\n \n <td>\n \n <a title=\"Allows removal of a completed form from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove a completed form and under what circumstances.\" href=\"#QuestionnaireResponse-delete\">SHALL</a>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>DocumentReference</th>\n \n <td>\n \n <a title=\"Allows discovery of existing documents that may be included in a form pre-population request\" href=\"#DocumentReference-search-type\">SHOULD</a>\n \n </td>\n \n <td/>\n \n <td/>\n \n <td/>\n \n <td/>\n \n <td/>\n \n <td/>\n \n <td/>\n \n </tr>\n \n <tr>\n \n <th>Binary</th>\n \n <td/>\n \n <td>\n \n <a title=\"Allows retrieval of a specific binary (as pointed to by a DocumentReference)\" href=\"#Binary-read\">SHOULD</a>\n \n </td>\n \n <td>\n \n <a title=\"Allows retrieval of a historical version of a binary. In general, the most recent version would be appropriate, but some may prefer to use the specific version referenced by a DocumentReference.\" href=\"#Binary-vread\">MAY</a>\n \n </td>\n \n <td/>\n \n <td/>\n \n <td/>\n \n <td/>\n \n <td/>\n \n </tr>\n \n </tbody>\n \n </table>\n \n <p>\n \n <b>Operations:</b>\n \n <a title=\"Populate Questionnaire\" href=\"http://hl7.org/fhir/OperationDefinition#questionnaire-populate\">populate</a> MAY\n </p>\n \n <br/>\n \n <br/>\n \n <h3>\n \n <a href=\"../questionnaire.html\">Questionnaire</a>\n \n </h3>\n \n <h4>Interactions</h4>\n \n <table class=\"list\">\n \n <thead>\n \n <tr>\n \n <th>Name</th>\n \n <th>Conformance</th>\n \n <th>Description</th>\n \n </tr>\n \n </thead>\n \n <tbody>\n \n <tr>\n \n <th>\n \n <a name=\"Questionnaire-search-type\"> </a>\n \n <span>search-type</span>\n \n </th>\n \n <td>SHALL</td>\n \n <td>\n \n <p>Allows discovery of existing questionnaires to be completed</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"Questionnaire-read\"> </a>\n \n <span>read</span>\n \n </th>\n \n <td>SHOULD</td>\n \n <td>\n \n <p>Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id.</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"Questionnaire-history-instance\"> </a>\n \n <span>history-instance</span>\n \n </th>\n \n <td>MAY</td>\n \n <td>\n \n <p>Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most.</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"Questionnaire-vread\"> </a>\n \n <span>vread</span>\n \n </th>\n \n <td>MAY</td>\n \n <td>\n \n <p>Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only.</p>\n \n </td>\n \n </tr>\n \n </tbody>\n \n </table>\n \n <br/>\n \n <br/>\n \n <h3>\n \n <a href=\"../valueset.html\">ValueSet</a>\n \n </h3>\n \n <h4>Interactions</h4>\n \n <table class=\"list\">\n \n <thead>\n \n <tr>\n \n <th>Name</th>\n \n <th>Conformance</th>\n \n <th>Description</th>\n \n </tr>\n \n </thead>\n \n <tbody>\n \n <tr>\n \n <th>\n \n <a name=\"ValueSet-read\"> </a>\n \n <span>read</span>\n \n </th>\n \n <td>SHALL</td>\n \n <td>\n \n <p>Allows retrieval of a specific value set by id (as referenced in a Questionnaire)</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"ValueSet-vread\"> </a>\n \n <span>vread</span>\n \n </th>\n \n <td>SHOULD</td>\n \n <td>\n \n <p>Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"ValueSet-history-instance\"> </a>\n \n <span>history-instance</span>\n \n </th>\n \n <td>MAY</td>\n \n <td>\n \n <p>Allows review of changes to a value set over time. Of interest to some systems, but probably not most.</p>\n \n </td>\n \n </tr>\n \n </tbody>\n \n </table>\n \n <br/>\n \n <br/>\n \n <h3>\n \n <a href=\"../questionnaireresponse.html\">QuestionnaireResponse</a>\n \n </h3>\n \n <h4>Interactions</h4>\n \n <table class=\"list\">\n \n <thead>\n \n <tr>\n \n <th>Name</th>\n \n <th>Conformance</th>\n \n <th>Description</th>\n \n </tr>\n \n </thead>\n \n <tbody>\n \n <tr>\n \n <th>\n \n <a name=\"QuestionnaireResponse-search-type\"> </a>\n \n <span>search-type</span>\n \n </th>\n \n <td>SHALL</td>\n \n <td>\n \n <p>Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update.</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"QuestionnaireResponse-create\"> </a>\n \n <span>create</span>\n \n </th>\n \n <td>SHALL</td>\n \n <td>\n \n <p>Allows recording a completed or partially-completed form</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"QuestionnaireResponse-update\"> </a>\n \n <span>update</span>\n \n </th>\n \n <td>SHALL</td>\n \n <td>\n \n <p>Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"QuestionnaireResponse-delete\"> </a>\n \n <span>delete</span>\n \n </th>\n \n <td>SHALL</td>\n \n <td>\n \n <p>Allows removal of a completed form from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove a completed form and under what circumstances.</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"QuestionnaireResponse-history-instance\"> </a>\n \n <span>history-instance</span>\n \n </th>\n \n <td>SHOULD</td>\n \n <td>\n \n <p>Allows review of prior versions of an answer set - allows reversion to previously recorded versions</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"QuestionnaireResponse-validate\"> </a>\n \n <span>validate</span>\n \n </th>\n \n <td>SHOULD</td>\n \n <td>\n \n <p>Allows checking an answer set for validity against submission rules without persisting any data</p>\n \n </td>\n \n </tr>\n \n </tbody>\n \n </table>\n \n <br/>\n \n <br/>\n \n <h3>\n \n <a href=\"../documentreference.html\">DocumentReference</a>\n \n </h3>\n \n <h4>Interactions</h4>\n \n <table class=\"list\">\n \n <thead>\n \n <tr>\n \n <th>Name</th>\n \n <th>Conformance</th>\n \n <th>Description</th>\n \n </tr>\n \n </thead>\n \n <tbody>\n \n <tr>\n \n <th>\n \n <a name=\"DocumentReference-search-type\"> </a>\n \n <span>search-type</span>\n \n </th>\n \n <td>SHOULD</td>\n \n <td>\n \n <p>Allows discovery of existing documents that may be included in a form pre-population request</p>\n \n </td>\n \n </tr>\n \n </tbody>\n \n </table>\n \n <br/>\n \n <br/>\n \n <h3>\n \n <a href=\"../binary.html\">Binary</a>\n \n </h3>\n \n <h4>Interactions</h4>\n \n <table class=\"list\">\n \n <thead>\n \n <tr>\n \n <th>Name</th>\n \n <th>Conformance</th>\n \n <th>Description</th>\n \n </tr>\n \n </thead>\n \n <tbody>\n \n <tr>\n \n <th>\n \n <a name=\"Binary-read\"> </a>\n \n <span>read</span>\n \n </th>\n \n <td>SHOULD</td>\n \n <td>\n \n <p>Allows retrieval of a specific binary (as pointed to by a DocumentReference)</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"Binary-vread\"> </a>\n \n <span>vread</span>\n \n </th>\n \n <td>MAY</td>\n \n <td>\n \n <p>Allows retrieval of a historical version of a binary. In general, the most recent version would be appropriate, but some may prefer to use the specific version referenced by a DocumentReference.</p>\n \n </td>\n \n </tr>\n \n </tbody>\n \n </table>\n \n </div>"
},
"name": "SDC Form Filler",
"status": "draft",
"publisher": "U.S. Office of the National Coordinator (ONC)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://wiki.siframework.org/Structured+Data+Capture+Initiative"
}
]
}
],
"date": "2014-07-06",
"description": "This profile defines the expected capabilities of the ''SDC Form Filler'' role when conforming to the S&I Framework's [[sdc|Structured Data Capture FHIR implementation guide]]. This role is responsible for retrieving pre-defined forms, requesting pre-population of forms and/or auto-populating forms, guiding the user through verifying populated data and submitting completed or partially-completed forms.<br/>Note that Form Fillers may also take on the role of [[conformance-sdc-form-archiver|Form Archiver]] if they have a requirement to retain the completed version of a form (and potentially the source data that was used to complete it).",
"kind": "requirements",
"fhirVersion": "1.2.0",
"acceptUnknown": "extensions",
"format": [
"xml",
"json"
],
"rest": [
{
"mode": "client",
"documentation": "The [[Questionnaire]] and [[ValueSet]] resources are retrieved to allow the system to guide the user through the entry process. The [[Binary]] and [[DocumentReference]] resources allow the system to find existing clinical documents that can be within the pre-population process. (Support for retrieval operations on these resources is optional as the relevant CDA or FHIR structures may also be directly generated by the ''Form Filler'' itself.) Finally, the [[QuestionnaireResponse]] resource is used to record the populated form.",
"security": {
"description": "Implementations must meet the general security requirements documented in the [[sdc-security|SDC implementation guide]]."
},
"resource": [
{
"type": "Questionnaire",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/sdc-questionnaire"
},
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type",
"documentation": "Allows discovery of existing questionnaires to be completed"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHOULD"
}
],
"code": "read",
"documentation": "Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance",
"documentation": "Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "MAY"
}
],
"code": "vread",
"documentation": "Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only."
}
]
},
{
"fhir_comments": [
" Do we want to define what search criteria must be supported? "
],
"type": "ValueSet",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/sdc-valueset"
},
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"code": "read",
"documentation": "Allows retrieval of a specific value set by id (as referenced in a Questionnaire)"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread",
"documentation": "Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance",
"documentation": "Allows review of changes to a value set over time. Of interest to some systems, but probably not most."
}
]
},
{
"type": "QuestionnaireResponse",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/sdc-element"
},
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type",
"documentation": "Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"code": "create",
"documentation": "Allows recording a completed or partially-completed form"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"code": "update",
"documentation": "Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"code": "delete",
"documentation": "Allows removal of a completed form from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove a completed form and under what circumstances."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance",
"documentation": "Allows review of prior versions of an answer set - allows reversion to previously recorded versions"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHOULD"
}
],
"code": "validate",
"documentation": "Allows checking an answer set for validity against submission rules without persisting any data"
}
]
},
{
"fhir_comments": [
" Do we want to define what search criteria must be supported? "
],
"type": "DocumentReference",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHOULD"
}
],
"code": "search-type",
"documentation": "Allows discovery of existing documents that may be included in a form pre-population request"
}
]
},
{
"fhir_comments": [
" Do we want to define what search criteria must be supported? "
],
"type": "Binary",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHOULD"
}
],
"code": "read",
"documentation": "Allows retrieval of a specific binary (as pointed to by a DocumentReference)"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "MAY"
}
],
"code": "vread",
"documentation": "Allows retrieval of a historical version of a binary. In general, the most recent version would be appropriate, but some may prefer to use the specific version referenced by a DocumentReference."
}
]
}
],
"operation": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "MAY"
}
],
"name": "populate",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition#questionnaire-populate",
"display": "Populate Questionnaire"
}
}
]
}
]
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU2 (v1.2.0-7447) generated on Fri, Dec 11, 2015 17:42+1100.
Links: Search |
Version History |
Table of Contents |
Compare to DSTU1 |
|
Propose a change